pp108 : multipleDownload (FTP)

multipleDownload (FTP)

This Web service operation is used to download multiple files.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <multipleDownload xmlns="http://schemas.cordys.com/ftpconnector/1.1">
            <configuration>ftpserver</configuration>
            <synchronous>true</synchronous>
            <notification-subject>FTP</notification-subject>
            <files>
                <path type="ascii">
                    <source>/readme.txt</source>
                    <target>C:\tempdocs\readme.txt</target>
                </path>
                <path type="ascii">
                    <source>\Legal\legal.txt</source>
                    <target>C:\tempdocs\leagal.txt</target>
                </path>
                <path type="ascii">
                    <source>\Development\license.txt</source>
                    <target>C:\tempdocs\license.txt</target>
                </path>
            </files>
        </multipleDownload>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Parameter

Description

configuration

Name of the Configuration Profile that contains the FTP server details.

synchronous

Specifies if the response must be intimated to the client. This can hold the following values:

  • true - The process will continue without any interruption and the FTP client would wait for the response.
  • false - The event handler will handle the response.

notification-subject

Notification subject on which the user has to subscribe to the Event service, to obtain the status of the request.

files

The files to be downloaded.

path

The path of a file or directory on the FTP server. The type attribute here specifies the type of files to upload (ascii or binary).

  • If you want to specify the binary file type in the request, set the value as bin.
  • If you want to specify the ASCII file type in the request, set the value as ascii.

type

The mode of transfer (ASCII or binary).

source

The source path of a file or directory.

target

The target path to which the source file or directory must be transferred.

SOAP Response

<multipleDownloadResponse
    xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <configuration xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">ftpserver</configuration>
    <notification-subject
        xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">FTP</notification-subject>
    <files xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <path type="ascii"
            xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
            <source>/readme.txt</source>
            <target>C:\tempdocs\readme.txt</target>
            <statuscode
                xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">226</statuscode>
            <status xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">Transfer complete. </status>
        </path>
        <path type="ascii"
            xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
            <source>\Legal\legal.txt</source>
            <target>C:\tempdocs\leagal.txt</target>
            <statuscode
                xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">226</statuscode>
            <status xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">Transfer complete. </status>
        </path>
        <path type="ascii"
            xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
            <source>\Development\license.txt</source>
            <target>C:\tempdocs\license.txt</target>
            <statuscode
                xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">226</statuscode>
            <status xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">Transfer complete. </status>
        </path>
    </files>
</multipleDownloadResponse>